Schema bimoL.v1
Schema bimoL.v1 > Typ złożony GetPaymentSummonResponse : Element success
Element success
Opis
Pozytywny rezultat przetwarzania operacji (sukces)
Przestrzeń nazw http://api.big.pl/bimoL/v1
Typ
Typ złożony GetPaymentSummonOrderSuccess
Diagram
Element paymentSummonOrder Element operationType Sequence Element success
Przegląd
success Typ złożony GetPaymentSummonOrderSuccess
Pozytywny rezultat przetwarzania operacji (sukces)
ordersCount optional xs:int
Liczba wszystkich zleceń wysyłki spełniających kryteria wyszukiwania.
Liczba wszystkich zleceń wysyłki spełniających kryteria wyszukiwania.
Powiązane reguły walidacji:

Identyfikator Opis
RDPS05 Brak konfiguracji szablonu dedykowanego dla wskazanego rodzaju zobowiązania. Konfigurację szblonu należy wykonać w profilu klienta w systemie biznes.big.pl
Sequence
operationType Typ prosty shippingOrderOperationEnum
Rodzaj operacji
Rodzaj wykonanej operacji
paymentSummonOrder 0..∞ Typ złożony PaymentSummonOrderDetails
Dane zlecenia wysyłki wezwania do zapłaty
configuredTemplate optional xs:boolean
Szablon dokumentu skonfigurowany przez klienta
Deklaracja wysyłki wezwania wygenerowanego z szablonu skonfigurowanego w portalu biznes.big.pl. Domyślnie atrybut przyjmuje wartość "falase".
Powiązane reguły walidacji:

Identyfikator Opis
RDPS05 Brak konfiguracji szablonu dedykowanego dla wskazanego rodzaju zobowiązania. Konfigurację szblonu należy wykonać w profilu klienta w systemie biznes.big.pl
notificationEmail optional Typ prosty email
Adres e-mail do notyfikacji
Adres e-mail na który mają być wysyłane wiadomości z informacjami o zmianach stanu realizacji zleconej wysyłki
Sequence
id 1..2 Typ złożony ObjectId
Identyfikator obiektu
Unikalny identyfikator obiektu (np. Informacji Gospodarczej) nadany przez system BIG InfoMonitor (@ObjectId/@type=internalId) lub nadany w systemie informatycznym subskrybenta (@ObjectId/@type=externalId). Zewnętrzny identyfikator musi zostać przekazany w przypadku operacji dodania obiektu. W przypadku aktualizacji lub usunięcia identyfikator zewnętrzny musi być podany, jeżeli nie podano identyfikatora wewnętrznego (nadanego przez system BIG InfoMonitor). Identyfikator wewnętrzny (nadany przez system BIG InfoMonitor) nie może być podany dla operacji dodania obiektu.
Powiązane reguły walidacji:

Identyfikator Opis
RDIG205 Identyfikator Informacji Gospodarczej w rejestrze BIG InfoMonitor nie może zostać przekazany w danych nowej Informacji Gospodarczej
RDIG206 Identyfikator Informacji Gospodarczej w rejestrze Subskrybenta musi być przekazany dokładnie jeden raz w danych nowej informacji gospodarczej
RDIG207 Identyfikator zobowiązania w rejestrze BIG InfoMonitor nie może zostać przekazany w danych nowego zobowiązania
RDIG208 Identyfikator zobowiązania w rejestrze subskrybenta musi być przekazany w danych zobowiązania nowej IG dokładnie jeden raz
RDIG22 Identyfikatory zobowiązań przekazane w danych nowej IG muszą być unikalne
RAIG311 Identyfikator IG w Rejestrze BIG InfoMonitor i Identyfikator IG w rejestrze Subskrybenta może być przekazany w danych aktualizowanej IG maksymalnie jeden raz
RAIG22 Próba przekazania nieunikalnych identyfikatorów zobowiązań w danych aktualizowanego IG
RDZ46 Identyfikator zobowiązania w rejestrze BIG InfoMonitora nie może zostać przekazany w danych nowego zobowiązania
RDZ47 Rodzaj identyfikatora (w rejestrze BIG Infomonitor lub w rejestrze subskrybenta), przypisanego do numeru identyfikującego dodawanego zobowiązania, może być przekazany maksymalnie jeden raz
RDIG217 Identyfikator IG w rejestrze Subskrybenta przekazany w danych nowej IG nie może być przypisany do innej IG o tym rodzaju (negatywnej, pozytywnej lub dokumencie kwestionowanym) utrzymywanej przez Subskrybenta w Rejestrze BIG InfoMonitor
RAIG224 Numer IG przekazany w danych aktualizowanej IG, musi być przypisany do IG utrzymywanej w Rejestrze Subskrybenta
RAIG225 Numery IG (w rejestrze subskrybenta i rejestrze BIG Infomonitor) przekazane w celu identyfikacji aktualizowanej IG muszą wskazywać ta samą IG
RAIG223 Identyfikatory przekazane w celu wskazania zobowiązania aktualizowanego (Identyfikator zobowiązania w rejestrze BIG InfoMonitor i rejestrze Subskrybenta) w operacji aktualizacji danych IG muszą być przypisane do jednego zobowiązania
RAD98 Identyfikatory IG przekazane w danych operacji aktualizacji danych dłużnika muszą być przypisane do IG zapisanej w rejestrze Subskrybenta
RAD103 Identyfikatory IG przekazane w danych operacji aktualizacji danych dłużnika muszą być przypisane do jednej IG zapisanej w rejestrze Subskrybenta
RDZ58 Identyfikator przekazany w danych dodawanego zobowiązania, nie może być identyfikatorem zobowiązania przypisanego do innego IG z rejestru Subskrybenta
RDIG219 Identyfikator zobowiązania w rejestrze Subskrybenta przekazany w danych nowej IG nie może być przypisany do innego zobowiązania o tym rodzaju (spełnionego, niespełnionego) utrzymywanego przez Subskrybenta w Rejestrze BIG InfoMonitor
RDIG220 Identyfikator IG w rejestrze Subskrybenta przekazany w danych nowej IG negatywnej nie może być przypisany do nieujawnionego szkicu długu utrzymywanego przez Subskrybenta w Rejestrze BIG InfoMonitor
RDIG222 Identyfikator niespełnionego zobowiązania w rejestrze Subskrybenta, przekazany w danych nowej IG nie może być przypisany do szkicu zobowiązania utrzymywanego przez Subskrybenta
RAIG222 Identyfikator zobowiązania przekazany w danych aktualizowanej negatywnej informacji gospodarczej nie może identyfikować szkicu zobowiązania tego Subskrybenta
RAIG1 Przekazanie atrybutu potwierdzającego dodanie IG w przypadku niezidentyfikowania IG do aktualizacji, może być możliwe tylko w przypadku operacji aktualizacji IG
RAIG205 Identyfikator Informacji Gospodarczej w rejestrze BIG InfoMonitor nie może zostać przekazany w danych aktualizowanej IG, jeżeli oznaczono opcję dodania IG w przypadku niezidentyfikowania IG dla której zlecono aktualizację
RUZ03 Rodzaj identyfikatora (w rejestrze BIG Infomonitor lub w rejestrze subskrybenta), przypisanego do numeru usuwanego zobowiązania, może być przekazany maksymalnie jeden raz
Brak opisu reguły.
idType optional Typ prosty idTypeEnum
Rodzaj identyfikatora obiektu
Rodzaj identyfikatora obiektu.
Powiązane reguły walidacji:

Identyfikator Opis
RDZ46 Identyfikator zobowiązania w rejestrze BIG InfoMonitora nie może zostać przekazany w danych nowego zobowiązania
RDZ47 Rodzaj identyfikatora (w rejestrze BIG Infomonitor lub w rejestrze subskrybenta), przypisanego do numeru identyfikującego dodawanego zobowiązania, może być przekazany maksymalnie jeden raz
RZKZ3 Rodzaj identyfikatora (w rejestrze BIG Infomonitor lub w rejestrze subskrybenta), przypisanego do numeru zobowiązania w kórym zleca sie zmianę kwot zobowiązania, może być przekazany maksymalnie jeden raz
debtorName Typ prosty string250
Nazwa dłużnika
Nazwa dłużnika prezentowana na wezwaniu
Powiązane reguły walidacji:

Identyfikator Opis
RZKZ18 Data i czas aktualności danych przekazany w operacji zmiany kwoty zobowiązania musi być późniejszy niż data i czas aktualności zapisany w danych tej IG
liability 1..∞ Typ złożony PaymentSummonLiability
Niespełnione zobowiązanie
Informacje dotyczące niespełnionego zobowiązania którego dotyczy wezwanie
Powiązane reguły walidacji:

Identyfikator Opis
RDPS03 Wszystkie zobowiązania przekazane w danych zlecownego wezwania do zapłaty, muszą mieć identyczny typ (zobowiązanie finansowe lub zobowiązania stwierdzone tytułem wykonawczym)
Sequence
overdueAmount Typ prosty amount
Kwota zaległości
Kwota należności wymagalnych
currency Typ prosty currencyEnum
Waluta
Kod waluty, w jakiej przekazywane są kwoty w ramach zobowiązania. Domyślnie przyjmowana jest wartość "PLN" - polski nowy złoty.
Powiązane reguły walidacji:

Identyfikator Opis
RDPS04 Wszystkie zobowiązania przekazane w zleceniu wysyłki wezwania do zapłaty muszą być opisane w takiej samej walucie
deliveryAddress Typ złożony Address
Adres do wysyłki
Adres na który ma być wysłane zlecone wezwanie
Sequence
country Typ prosty countryEnum
Kod kraju
Kod identyfikujący kraj zawarty w adresie.
accountNumber Typ prosty string30
Numer rachunku bankowego
Numer rachunku bankowego wierzyciela, na który dłużnik powinien dokonać zwrotu długu, który będzie umieszczony na wezwaniu do zapłaty.
orderDate xs:dateTime
Data zlecenia
Data i czas zlecenia wysyłki wezwania
status Typ prosty paymentSummonOrderStatusEnum
Status zlecenia wysyłki
Aktualny status zlecenia wysyłki
sentDate optional xs:date
Data wysyłki wezwania
Data w której wysłano wezwanie do zapłaty
shipmentNumber optional Typ prosty string32
Numer nadania wysyłki
Numer nadania wysyłki listu z wezwaniem do zapłaty, który został nadany przez pocztę
clientId Typ prosty id
Identyfikator subskrybenta wierzyciela, który zlecił wysyłkę wezwania
Unikalny identyfikator nadawany przez BIG InfoMonitor każdemu subskrybentowi w ramach systemu.
proxyClientId optional Typ prosty id
Identyfikator subskrybenta który zlecił wysyłkę wezwania w imieniu wierzyciela
Unikalny identyfikator nadawany przez BIG InfoMonitor każdemu subskrybentowi w ramach systemu.
pdf optional Typ prosty string
PDF z obrazem wezwania do zapłaty
Plik PDF zakodowany w base64
Źródło
<xs:element name="success" type="bl:GetPaymentSummonOrderSuccess" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Pozytywny rezultat przetwarzania operacji (sukces)</div>
    </xs:documentation>
  </xs:annotation>
</xs:element>
Zobacz także
Typ złożony GetPaymentSummonResponse | Schema bimoL.v1